CE Gobi SDK  2.7
GobiApi
PlaceHolder.h
1 /*===========================================================================
2 FILE:
3  PlaceHolder.h
4 
5 DESCRIPTION:
6  API place holders
7 
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9  Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11 
12 #ifndef __Place_Holder_H__
13 #define __Place_Holder_H__
14 
15 #ifdef __cplusplus
16  extern "C" {
17 #endif
18 
19 #ifdef __cplusplus
20  };
21 #endif
22 
23 /*=========================================================================*/
24 // Prototypes
25 /*=========================================================================*/
26 
27 /*===========================================================================
28 METHOD:
29  OriginateUSSD
30 
31 DESCRIPTION:
32  This function initiates a USSD operation
33  placeholder function only
34 
35 PARAMETERS:
36  pInfo [ I ] - USSD information
37 
38 RETURN VALUE:
39  ULONG - Return code
40 ===========================================================================*/
41 IMPORTGOBI ULONG GOBICMAPI OriginateUSSD( BYTE * pInfo );
42 
43 
44 /*===========================================================================
45 METHOD:
46  AnswerUSSD
47 
48 DESCRIPTION:
49  This function responds to a USSD request from the network
50  placeholder function only
51 
52 PARAMETERS:
53  pInfo [ I ] - USSD information
54 
55 RETURN VALUE:
56  ULONG - Return code
57 ===========================================================================*/
58 IMPORTGOBI ULONG GOBICMAPI AnswerUSSD( BYTE * pInfo );
59 
60 /*===========================================================================
61 METHOD:
62  CancelUSSD
63 
64 DESCRIPTION:
65  This function cancels an in-progress USSD operation
66  placeholder function only
67 
68 RETURN VALUE:
69  ULONG - Return code
70 ===========================================================================*/
71 IMPORTGOBI ULONG GOBICMAPI CancelUSSD();
72 
73 /*===========================================================================
74 METHOD:
75  SetWirelessDisableCallback
76 
77 DESCRIPTION:
78  Enables/disables wireless disable state callback function
79 
80 PARAMETERS:
81  pCallback [ I ] - Callback function
82 
83 RETURN VALUE:
84  ULONG
85 ===========================================================================*/
86 IMPORTGOBI ULONG GOBICMAPI SetWirelessDisableCallback(
87  tFNWirelessDisable pCallback );
88 
89 
90 /*===========================================================================
91 METHOD:
92  DMSUIMGetControlKeyBlockingStatus
93 
94 DESCRIPTION:
95  This function returns the blocking status of the specified facility
96  control key
97  Depreciated, function place holder only.
98 
99 PARAMETERS:
100  id [ I ] - Facility ID
101  pStatus [ O ] - Control key status
102  pVerifyRetriesLeft [ O ] - The number of retries left, after which the
103  control key will be blocked
104  pUnblockRetriesLeft [ O ] - The number of unblock retries left, after
105  which the control key will be permanently
106  blocked
107  pbBlocking [ O ] - (Optional) Is the facility blocking?
108 
109 RETURN VALUE:
110  ULONG - Return code
111 ===========================================================================*/
112 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyBlockingStatus(
113  ULONG id,
114  ULONG * pStatus,
115  ULONG * pVerifyRetriesLeft,
116  ULONG * pUnblockRetriesLeft,
117  ULONG * pbBlocking );
118 
119 /*===========================================================================
120 METHOD:
121  SetLock
122 
123 DESCRIPTION:
124  This function sets the user lock state maintained by the device
125  Depreciated. Place holder only.
126 
127 PARAMETERS:
128  state [ I ] - Desired lock state
129  pCurrentPIN [ I ] - Current four digit PIN string
130 
131 RETURN VALUE:
132  ULONG - Return code
133 ===========================================================================*/
134 IMPORTGOBI ULONG GOBICMAPI SetLock(
135  ULONG state,
136  CHAR * pCurrentPIN );
137 
138 /*===========================================================================
139 METHOD:
140  QueryLock
141 
142 DESCRIPTION:
143  This function sets the user lock state maintained by the device
144  Depreciated. Place holder only.
145 
146 PARAMETERS:
147  pState [ O ] - Current lock state
148 
149 RETURN VALUE:
150  ULONG - Return code
151 ===========================================================================*/
152 IMPORTGOBI ULONG GOBICMAPI QueryLock( ULONG * pState );
153 
154 /*===========================================================================
155 METHOD:
156  ChangeLockPIN
157 
158 DESCRIPTION:
159  This command sets the user lock code maintained by the device
160  Depreciated. Place holder only.
161 
162 PARAMETERS:
163  pCurrentPIN [ O ] - Current four digit PIN string
164  pDesiredPIN [ O ] - New four digit PIN string
165 
166 RETURN VALUE:
167  ULONG - Return code
168 ===========================================================================*/
169 IMPORTGOBI ULONG GOBICMAPI ChangeLockPIN(
170  CHAR * pCurrentPIN,
171  CHAR * pDesiredPIN );
172 
173 /*===========================================================================
174 METHOD:
175  GetSignalStrength
176 
177 DESCRIPTION:
178  This function gets the current signal strength (in dBm) as measured by
179  the device, the signal strength returned will be one of the currently
180  available technologies with preference CDMA 1xEV-DO, CDMA, AMPS, LTE,
181  WCDMA, GSM
182  Depreciated. Place Holder only
183 
184 PARAMETERS:
185  pSignalStrength [ O ] - Received signal strength (dBm)
186  pRadioInterface [ O ] - Radio interface technology
187 
188 RETURN VALUE:
189  ULONG - Return code
190 ===========================================================================*/
191 IMPORTGOBI ULONG GOBICMAPI GetSignalStrength(
192  INT8 * pSignalStrength,
193  ULONG * pRadioInterface );
194 
195 #endif